<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>rlblackjack: blackrlenv.BlackRLEnv Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">rlblackjack
   &#160;<span id="projectnumber">0.1</span>
   </div>
   <div id="projectbrief">Reinforcement Learning as Applied to Casino Blackjack</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>blackrlenv</b></li><li class="navelem"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html">BlackRLEnv</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classblackrlenv_1_1_black_r_l_env-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">blackrlenv.BlackRLEnv Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for blackrlenv.BlackRLEnv:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classblackrlenv_1_1_black_r_l_env.png" usemap="#blackrlenv.BlackRLEnv_map" alt=""/>
  <map id="blackrlenv.BlackRLEnv_map" name="blackrlenv.BlackRLEnv_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3fb367524c6aad7cdaf13919efffe25d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#a3fb367524c6aad7cdaf13919efffe25d">__init__</a></td></tr>
<tr class="separator:a3fb367524c6aad7cdaf13919efffe25d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b2c34948bf1717c493a613fa0046c27"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#a5b2c34948bf1717c493a613fa0046c27">reset</a></td></tr>
<tr class="separator:a5b2c34948bf1717c493a613fa0046c27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5b10e0c55750ecf8377f5ea73142157"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#ae5b10e0c55750ecf8377f5ea73142157">getSensors</a></td></tr>
<tr class="separator:ae5b10e0c55750ecf8377f5ea73142157"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fee88e042f84da39e3e76c8b1e28a55"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#a0fee88e042f84da39e3e76c8b1e28a55">performAction</a></td></tr>
<tr class="separator:a0fee88e042f84da39e3e76c8b1e28a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aaf309fb54d78aa5388bad0b32fecdc9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf309fb54d78aa5388bad0b32fecdc9b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>topology</b></td></tr>
<tr class="separator:aaf309fb54d78aa5388bad0b32fecdc9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec3106f2b79667ea9626ad723e08498b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec3106f2b79667ea9626ad723e08498b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>goal</b></td></tr>
<tr class="separator:aec3106f2b79667ea9626ad723e08498b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ad92897b3bf6c1f56d677b529612108"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ad92897b3bf6c1f56d677b529612108"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>shoe</b></td></tr>
<tr class="separator:a2ad92897b3bf6c1f56d677b529612108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3d193b605516fb5df814b076c1aa880"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3d193b605516fb5df814b076c1aa880"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>count</b></td></tr>
<tr class="separator:ae3d193b605516fb5df814b076c1aa880"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a3b2c13501851dcee455103abc7b94857"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b2c13501851dcee455103abc7b94857"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#a3b2c13501851dcee455103abc7b94857">indim</a> = 0</td></tr>
<tr class="memdesc:a3b2c13501851dcee455103abc7b94857"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of actions the environment accepts. <br/></td></tr>
<tr class="separator:a3b2c13501851dcee455103abc7b94857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba4c7413c040a5bca8e7e94946e7f71"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaba4c7413c040a5bca8e7e94946e7f71"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#aaba4c7413c040a5bca8e7e94946e7f71">outdim</a> = 0</td></tr>
<tr class="memdesc:aaba4c7413c040a5bca8e7e94946e7f71"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of states the environment produces. <br/></td></tr>
<tr class="separator:aaba4c7413c040a5bca8e7e94946e7f71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe1030aacc11e18193cf1e29d9766958"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe1030aacc11e18193cf1e29d9766958"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#afe1030aacc11e18193cf1e29d9766958">discreteStates</a> = True</td></tr>
<tr class="memdesc:afe1030aacc11e18193cf1e29d9766958"><td class="mdescLeft">&#160;</td><td class="mdescRight">Discrete State Space. <br/></td></tr>
<tr class="separator:afe1030aacc11e18193cf1e29d9766958"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10d1e57d2be1d80adad8fa200bf7a506"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10d1e57d2be1d80adad8fa200bf7a506"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#a10d1e57d2be1d80adad8fa200bf7a506">discreteActions</a> = True</td></tr>
<tr class="memdesc:a10d1e57d2be1d80adad8fa200bf7a506"><td class="mdescLeft">&#160;</td><td class="mdescRight">Discrete Action Space. <br/></td></tr>
<tr class="separator:a10d1e57d2be1d80adad8fa200bf7a506"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a174ec4f2d1a77b339e5268e402e7159f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a174ec4f2d1a77b339e5268e402e7159f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#a174ec4f2d1a77b339e5268e402e7159f">numActions</a> = 0</td></tr>
<tr class="memdesc:a174ec4f2d1a77b339e5268e402e7159f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of possible actions within the discrete action space. <br/></td></tr>
<tr class="separator:a174ec4f2d1a77b339e5268e402e7159f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd09072b318953c9e4df19f8ab5f1735"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd09072b318953c9e4df19f8ab5f1735"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#acd09072b318953c9e4df19f8ab5f1735">perseus</a> = None</td></tr>
<tr class="memdesc:acd09072b318953c9e4df19f8ab5f1735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current State. <br/></td></tr>
<tr class="separator:acd09072b318953c9e4df19f8ab5f1735"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2f43756cec4a6132c6355406818c452"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblackrlenv_1_1_black_r_l_env.html#aa2f43756cec4a6132c6355406818c452">action_set</a> = [<a class="el" href="classactions_1_1_actions.html#ae365b3ff7b564cf6f198baf0377340d7">Actions.HIT</a>, <a class="el" href="classactions_1_1_actions.html#a901153919cfcb1c34a29321f79603fc0">Actions.STAND</a>]</td></tr>
<tr class="memdesc:aa2f43756cec4a6132c6355406818c452"><td class="mdescLeft">&#160;</td><td class="mdescRight">Possible Actions the agent can perform.  <a href="#aa2f43756cec4a6132c6355406818c452">More...</a><br/></td></tr>
<tr class="separator:aa2f43756cec4a6132c6355406818c452"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is the logic for the reinforcement learning environment. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3fb367524c6aad7cdaf13919efffe25d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def blackrlenv.BlackRLEnv.__init__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>topology</em> = <code>[]</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>goal</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>args</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Class constructor that sets a known framework for the learning. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae5b10e0c55750ecf8377f5ea73142157"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def blackrlenv.BlackRLEnv.getSensors </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This returns the items that are used to create the state of the system. </p>
<dl class="section pre"><dt>Precondition</dt><dd>none </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>none </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">none</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The perseus, representing the player and dealer hands. </dd></dl>

</div>
</div>
<a class="anchor" id="a0fee88e042f84da39e3e76c8b1e28a55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def blackrlenv.BlackRLEnv.performAction </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>action</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Performs the desired actions of the agent. </p>
<dl class="section pre"><dt>Precondition</dt><dd>none </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>Updated state based on the desired action. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">action</td><td>The desired action of the agent. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
<a class="anchor" id="a5b2c34948bf1717c493a613fa0046c27"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def blackrlenv.BlackRLEnv.reset </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This reset, takes all cards from the dealer and player and gives them new cards. </p>
<dl class="section pre"><dt>Precondition</dt><dd>none </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>perseus is updated with the dealer and player hands. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">none</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa2f43756cec4a6132c6355406818c452"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">blackrlenv.BlackRLEnv.action_set = [<a class="el" href="classactions_1_1_actions.html#ae365b3ff7b564cf6f198baf0377340d7">Actions.HIT</a>, <a class="el" href="classactions_1_1_actions.html#a901153919cfcb1c34a29321f79603fc0">Actions.STAND</a>]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Possible Actions the agent can perform. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>rlblackjack/<a class="el" href="blackrlenv_8py.html">blackrlenv.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 4 2013 03:17:33 for rlblackjack by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
